home *** CD-ROM | disk | FTP | other *** search
/ EuroCD 3 / EuroCD 3.iso / Communication / Citadel_BBS / Docs / cit_hlp.lha / TOC.HLP < prev    next >
Encoding:
Text File  |  1994-05-23  |  6.3 KB  |  149 lines
  1.  File Listings
  2.  -------------
  3.    ^variantname allows access to files via special "directory rooms".  You
  4. can identify a directory room by its prompt.  Normal rooms have a ">" (as
  5. in "East Bloc>"), while directory rooms have a "]" (as in "Upload Room]").
  6.  
  7.    In order to do anything useful with directory rooms, you usually need to
  8. know what's in them (hence the name of this help file, TOC, or "Table Of
  9. Contents").  ^variantname has two basic commands available, both
  10. extensions of the .Read command.
  11.  
  12.    The first is
  13.  
  14.      <.R>ead <E>xtended-directory <CR>
  15.  
  16.    This command will list the file's names available in the current directory
  17. room in the following format:
  18.  
  19.  <filename>     <filesize in bytes> | <file comment, if any>
  20.  
  21.    The second command is
  22.  
  23.      <.R>ead <D>irectory <CR>
  24.  
  25.    This command lists the file's names followed by their size in 128 byte
  26. chunks (i.e., number of sectors the file takes up), like this:
  27.  
  28.  <filename>  <size>  <filename>  <size> ...
  29.  
  30.    .Read Directory is useful for short quick scans of directories, while
  31. the slower .Read Extended-directory is useful for getting more information
  32. (provided by the sysop or the uploaders) on the files (file comments can
  33. be anything from nothing to veritable tomes).
  34.  
  35.  Options
  36.     The two above commands have a variety of options you can attach to them.
  37. In the interests of clarity, we'll only show examples using .Read Extended;
  38. please just assume you can use them with .Read Directory as well.  Also, we're
  39. going to dispense with the "<..>" convention for the balance of this help
  40. file, because the ">" and "<" are actually of use in some of the options
  41. which follow.
  42.  
  43.    The first option is the use of a "file-spec".  A file spec is a way to
  44. specify only a certain set of files should be selected for display.  When
  45. specifying a file-spec, a '*' means match 0 or more characters, while a '?'
  46. means match only one.  For instance, if you only wanted to see files starting
  47. with the letters DU (like files DUMMY and DUMB), you might type "DU*".  Or
  48. you might type "DU*.*", because of the peculiarities of some operating systems
  49. (ahem).
  50.  
  51.    In any case, when you typed
  52.  
  53.      .<R>ead <E>xtended-directory
  54.  
  55.    the implication is that you meant "*.*" or "*" (again, depending on the
  56. operating system).  You may, instead of typing a carriage soon after the
  57. ".RE", type in a file-spec.  To use our previous example,
  58.  
  59.      .<R>ead <E>xtended-directory DU*.*
  60.  
  61.    is perfectly valid and will display all the files which "match" (computer
  62. jargon) the file-spec, including DUMB and DUMMY -- if such files are actually
  63. in the current room, of course.
  64.  
  65.    Additionally, you are not limited to one file-spec.
  66.  
  67.      .<R>ead <E>xtended-directory DU*.* *.DOC
  68.  
  69.    is perfectly valid.  In general, you separate each file-spec from the next
  70. by one or more spaces, and ^variantname will show all files which match any
  71. of those file-specs.
  72.  
  73.    Using a file-spec is fairly mundane.  ^variantname also allows you to
  74. use a "date-spec".  A date-spec tells ^variantname to "match" (once again)
  75. only those files which match both the file-spec you may or may not have typed
  76. in, and also the date-spec.  A date-spec is a means to select files who's
  77. date is either before or after some date you specify.  Generically, a date-spec
  78. looks like this:
  79.  
  80.      < or > followed by a date specification.
  81.  
  82.    A date specification is in ^variantname format: yymmdd, where yy is not
  83. needed unless the year you're matching against is not the current year.  The
  84. "< or >" means you may use one or the other.  ">" means "since", while "<"
  85. means "before".  (If you forget to use either, ^variantname will think your
  86. date-spec is a file-spec).  So if you wanted to see all the files in the
  87. directory with a date on or after December 1st, 1989, you'd type
  88.  
  89.      .<R>ead <E>xtended-directory > 89Dec1
  90.  
  91.    Similarly, you can actually search for files in a range by simply using
  92. two date-specs.  If you wanted to find all the files dated between July 1st,
  93. 1989, and December 1st, 1989, you'd type
  94.  
  95.      .<R>ead <E>xtended-directory > 89Jul1 < 89Dec1
  96.  
  97.    Naturally, you can use file-specs with date-specs, but file-specs must
  98. precede date-specs.
  99.  
  100.    Now, naturally, it's always nice to find all files dated since the last
  101. time you logged in.  Many upload protocols simply date-stamp each file with
  102. the current time when the file was uploaded, which makes it especially
  103. enticing to know what was uploaded since you were last on (but some popular
  104. protocols do preserve the "real" date of the file, which defeats this scheme).
  105. Using the above scheme, you'd have to remember the date of your last login
  106. to achieve what we're talking about, so ^variantname provides a shortcut:
  107. simply using "<" or ">" without an actual date-spec defaults to the date you
  108. were last on.  For instance, to list the names of all files dated since you
  109. were last on, you'd type
  110.  
  111.      .<R>ead <E>xtended-directory >
  112.  
  113.    Nice and simple.
  114.  
  115.    Now for an odd option.  If you've experimented, you've seen the file comments
  116. ^variantname will display for you when you use .Read Extended.  Now suppose
  117. you want to find a file in a big directory room which you'd seen before, but all
  118. you can remember is part of the comment, and not the name.  Rather than doing
  119. a .Read Extended and then scanning the entire list for what you want, wouldn't
  120. it be nice if you could actually scan using the comment as something to search
  121. on?  Well, you can!
  122.  
  123.      .<R>ead <P>hrase <E>xtended-directory ...
  124.  
  125.    will, after your ending carriage return, prompt you for a search phrase.
  126. Then all of the files which have a comment that has that phrase in it will
  127. be displayed.
  128.  
  129.    Finally, ^variantname provides you with the capability to scan ALL the
  130. directory rooms you know about using all of the commands so noted, by simply
  131. specifying the <G>lobal option.
  132.  
  133.      .<R>ead <G>lobal <E>xtended-directory ...
  134.  
  135.    The system will go through ALL the directory rooms you know about, scanning
  136. for the file-specs and date-specs you specified, if any.  This is very handy
  137. for finding all the files dated since the last time you were on ...
  138.  
  139.      .<R>ead <G>lobal <E>xtended-directory >
  140.  
  141.  
  142.  %UPLOAD Information on uploading to ^nodetitle.
  143.  %DOWNLOAD Information on downloading from ^nodetitle.
  144.  %FILES Summary of file handling.
  145.  %ADVANCED Back to the advanced commands help menu.
  146.  %HELPOPT Get a list of all help files in the system.
  147.  %MAINHELP First level of help system.
  148.  
  149.